Workflow Status

The Status API returns information about the status of the transaction. This is typically used to verify that the transaction has completed before retrieving the details.

Example Status Response 

{
	"account": {
		"id": "42ff9aeb-62ce-4481-99bd-b56346a4ba1a",
		"href": "https://retrieval.amer-1.jumio.ai/api/v1/accounts/42ff9aeb-62ce-4481-99bd-b56346a4ba1a"
	},
	"workflowExecution": {
		"id": "c3257562-941c-440c-bc9b-f59478bb48ef",
		"href": "https://retrieval.amer-1.jumio.ai/api/v1/workflow-executions/c3257562-941c-440c-bc9b-f59478bb48ef",
		"definitionKey": "10011",
		"status": "PROCESSED"
	}
}

 

Parameter Type Note
account object Possible values:• account.id• account.href
account.id string UUID of the account
account.href string URL to retrieve account details
workflowExecution object Possible values:• workflowExecution.id• workflowExecution.href• workflowExecution.definitionKey• workflowExecution.status
workflowExecution.id string UUID of the workflow
workflowExecution.href string URL to retrieve workflow details
workflowExecution.definitionKey string Key of the workflow definition which you executedSeesupported keys
workflowExecution.status string Possible values:
  • INITIATED

    Waiting for credentials to be uploaded and the transaction finalized.

  • ACQUIRED

    Transaction has been finalized but processing has not completed.

  • PROCESSED

    The transaction is completed.

  • SESSION_EXPIRED

    The session expired prior to finalization.

  • TOKEN_EXPIRED

    The authorization token expired prior to finalization.